home *** CD-ROM | disk | FTP | other *** search
/ Turnbull China Bikeride / Turnbull China Bikeride - Disc 1.iso / ARGONET / PD / DTP / PDF071E.ZIP / Docs / xpdf_docs / README < prev    next >
Text File  |  1997-05-29  |  12KB  |  345 lines
  1. xpdf
  2. ====
  3. and: pdftops, pdftotext
  4.  
  5. version 0.7 (beta)
  6. 97-may-28
  7.  
  8. The xpdf, pdftops, and pdftotext software and documentation are
  9. copyright 1996, 1997 Derek B. Noonburg.
  10.  
  11. Email: derekn@ece.cmu.edu
  12. WWW: http://www.contrib.andrew.cmu.edu/usr/dn0o/xpdf/xpdf.html
  13.  
  14. The PDF data structures, operators, and specification are
  15. copyright 1995 Adobe Systems Inc.
  16.  
  17.  
  18. What is xpdf?
  19. -------------
  20.  
  21. Xpdf is a viewer for Portable Document Format (PDF) files.  (These are
  22. also sometimes also called 'Acrobat' files, from the name of Adobe's
  23. PDF software.)  Xpdf runs under the X Window System on UNIX, VMS, and
  24. OS/2.
  25.  
  26. Xpdf is designed to be small and efficient.  It does not use the Motif
  27. or Xt libraries.  It uses standard X fonts.  Xpdf is quite usable on a
  28. 486-66 PC running Linux.
  29.  
  30.  
  31. Compatibility
  32. -------------
  33.  
  34. I have compiled xpdf on the following systems:
  35.  
  36. * x86, Linux 2.0 ELF
  37. * PowerPC, AIX 4.1
  38. * SPARC, Solaris 2.5
  39. * Alpha, OSF/1 3.2
  40. * HP-PA, HP-UX 9.05
  41.  
  42. In addition, it has been compiled by others on Solaris, SCO UnixWare,
  43. Digital Unix, Irix, and numerous other Unix implementations, as well
  44. as VMS, and OS/2.  It should work on pretty much any system which runs
  45. X11 and has Unix-like libraries.  You'll need ANSI C++ and C compilers
  46. to compile it.  If you compile it for a system not listed on the xpdf
  47. web page, please let me know.  If you're willing to make your binary
  48. available by ftp or on the web, I'll add a pointer to the web page.
  49. If you can't get it to compile on your system, I'll try to help.
  50.  
  51.  
  52. Getting xpdf
  53. ------------
  54.  
  55. The latest version is available from:
  56.  
  57.   http://www.contrib.andrew.cmu.edu/usr/dn0o/xpdf/xpdf.html
  58.  
  59. or:
  60.  
  61.   ftp://ftp.andrew.cmu.edu/pub/xpdf/
  62.  
  63. Source code and several precompiled executables are available.
  64.  
  65. Announcements of new versions are posted to several newsgroups
  66. (comp.text.pdf, comp.os.linux.announce, and others) and emailed to a
  67. list of people.  If you'd like to receive email notification of new
  68. versions, just let me know.
  69.  
  70.  
  71. Running xpdf
  72. ------------
  73.  
  74. To run xpdf, simply type:
  75.  
  76.   xpdf file.pdf
  77.  
  78. To generate a PostScript file, hit the "print" button in xpdf, or run
  79. pdftops:
  80.  
  81.   pdftops file.pdf
  82.  
  83. To generate a plain text file, run pdftotext:
  84.  
  85.   pdftotext file.pdf
  86.  
  87. Command line options and many other details are described in the man
  88. pages (xpdf.1, pdftops.1, and pdftotext.1) and the VMS help files
  89. (xpdf.hlp, pdftops.hlp, and pdftotext.hlp).
  90.  
  91.  
  92. Fonts
  93. -----
  94.  
  95. Xpdf uses X server fonts.  It requires the following fonts:
  96.  
  97. * Courier: medium-r, bold-r, medium-o, and bold-o
  98. * Helvetica: medium-r, bold-r, medium-o, and bold-o
  99. * Times: medium-r, bold-r, medium-i, and bold-i
  100. * Symbol: medium-r
  101. * Zapf Dingbats: medium-r
  102.  
  103. Most X installations should already have all of these fonts, except
  104. Zapf Dingbats.  You can install a Type 1 Zapf Dingbats font -- see the
  105. mkfontdir(1) man page for details.  Use this font descriptor in your
  106. fonts.scale file:
  107.  
  108.     -itc-zapfdingbats-medium-r-normal--0-0-0-0-p-0-adobe-fontspecific
  109.  
  110. You can get a Type 1 font file from the ghostscript 4.x distribution
  111. (look for d050000l.pfb).
  112.  
  113. X servers, starting at R5, support font scaling.  Xpdf will
  114. automatically take advantage of this.  There are two types of scaling.
  115. The first type uses standard bitmap fonts: if a font doesn't exist in
  116. the requested size, the server will scale the bitmapped characters.
  117. This is reasonably fast, and the results are readable but not very
  118. pretty.  X servers can also handle true scalable, e.g., Type 1, fonts.
  119. (See the mkfontdir(1) man page for details on setting these up.)
  120. Scalable fonts are slower, especially since PDF documents tend to use
  121. lots of fonts, but they look much nicer.
  122.  
  123. Some X servers also support font rotation.  Xpdf will use this feature
  124. if available.
  125.  
  126.  
  127. The Unisys LZW Patent
  128. ---------------------
  129.  
  130. Nearly all PDF files include data which has been compressed with the
  131. LZW compression algorithm.  Unfortunately, LZW is covered by a
  132. software patent which is owned by Unisys Corporation.  Unisys refuses
  133. to license this patent for PDF-related use in software such as xpdf
  134. which is released for free and which may be freely redistributed.
  135. (This is same algorithm which is used by GIF.  However, Unisys is not
  136. doing licensing for free PDF viwers in the same way as for free GIF
  137. viewers.)
  138.  
  139. As a workaround, xpdf converts PDF-format LZW data to compress-format
  140. LZW data.  (The standard UNIX compress utility also uses LZW, but with
  141. a slightly different file format.)  This conversion does *not*
  142. decompress the data; it simply converts it to a different file format.
  143. Xpdf then calls uncompress to actually decompress the data.
  144.  
  145. I have been told by several notable people that the LZW patent covers
  146. compression only, and does not cover decompression.  This seems pretty
  147. fuzzy to me, so I'm going to stick with my workaround, at least for
  148. now.
  149.  
  150. Software patents in general are a bad idea.  Consider supporting the
  151. League for Programming Freedom <http://www.lpf.org/>.
  152.  
  153. For Unisys's slant on things (mostly regarding GIF), see
  154. <http://www.unisys.com/LeadStory/lzwterms.html> and
  155. <http://www.unisys.com/LeadStory/lzwfaq.html>.  These pages mention
  156. an email address for feedback.
  157.  
  158.  
  159. Compiling xpdf
  160. --------------
  161.  
  162. Xpdf is written in C++ (with a little bit of C).  It should work with
  163. any ANSI-compliant C++ and C compilers.  The systems and compilers
  164. it's been tested with are listed on the xpdf web page.
  165.  
  166. To compile xpdf for UNIX:
  167.  
  168. * Edit Makefile.config in the top-level directory.  Set the compilers
  169.   you want to use (e.g., gcc and g++) and add any necessary switches
  170.   and options (e.g., include and library directories).  You can also
  171.   set the installation directory here (the PREFIX variable).  If you
  172.   have the Xpm (pixmap) library, remove '-DNO-XPM' from CFLAGS2 and
  173.   uncomment the XPMLIB definition (the only thing this adds to xpdf is
  174.   a nifty color icon).
  175.  
  176. * If neither 'uncompress -c file.Z' nor 'gzip -d -c file.Z' decompress
  177.   a standard UNIX .Z file to stdout on your system, you'll need to
  178.   change uncompressCmd in xpdf/config.h.  This should not be necessary
  179.   on most systems.
  180.  
  181. * Type 'make' in the top-level directory to compile both xpdf and
  182.   pdftops.  If you only want to make one of the executables, type
  183.   'make xpdf' or 'make pdftops'.
  184.  
  185. * If nothing goes wrong, the executables will be left in xpdf/xpdf and
  186.   xpdf/pdftops.  There are no runtime configuration or support files;
  187.   the binary can be moved to any directory.
  188.  
  189. * If desired, type 'make install' to install the binaries and man
  190.   pages.
  191.  
  192. The above instructions will also work for OS/2 with the EMX runtime
  193. environment and XFree86.  If you have trouble with this, contact Peter
  194. Ganten (j09g@zfn.uni-bremen.de).
  195.  
  196. To compile xpdf for VMS:
  197.  
  198. * There are two sets of scripts: vmscomp.com (for gcc on VAX) and
  199.   vmsdecccomp.com (for DEC C on Alpha).  There are four of each: in
  200.   the top-level directory, [.goo], [.ltk], and [.xpdf].  You may need
  201.   to edit these scripts as appropriate for your system.
  202.  
  203. * The 'stddef.h' include file which comes with older versions of gcc
  204.   may be missing a definition for wchar_t.  In this case, add the
  205.   following lines:
  206.   -----
  207.   File GNU_CC:[INCLUDE]STDDEF.H;2
  208.    44   /* Wide characters, not yet supported by VAXCRTL [match VAXC's <stddef.
  209.    45   #if !defined(_WCHAR_T) && !defined(_WCHAR_T_)
  210.    46   typedef unsigned int wchar_t;
  211.    47   #endif
  212.    48   #define _WCHAR_T
  213.    49   #define _WCHAR_T_
  214.    50
  215.   -----
  216.  
  217. * Type '@vmscomp' or '@vmsdecccomp' in the top-level directory.
  218.  
  219. * The executables will be left in '[.xpdf]xpdf' and '[.xpdf]pdftops'.
  220.  
  221.  
  222. Distribution
  223. ------------
  224.  
  225. Xpdf may be distributed under the following conditions:
  226.  
  227. 1. This file ('README') is included, unmodified, in the distribution.
  228.  
  229. 2. The distribution includes:
  230.    a. all of the xpdf source code and documentation, unmodified; OR
  231.    b. one or more xpdf executables, compiled from the unmodified
  232.       source code, plus the associated documentation (UNIX man pages
  233.       or VMS help files); OR
  234.    c. both of the above.
  235.  
  236. If you distribute xpdf, I would appreciate receiving a pointer (ftp
  237. site, BBS phone number, etc.) or a copy (disk, CD-ROM, etc.).
  238.  
  239. Modified versions of xpdf or applications using some or all of the
  240. xpdf code (i.e., 'derivative works' under copyright law) may not be
  241. distributed without explicit permission.
  242.  
  243.  
  244. Bugs
  245. ----
  246.  
  247. This is an beta release of xpdf, and there are still a bunch of PDF
  248. features which I have yet to implement.
  249.  
  250. At this point, the biggest problem is that embedded fonts are not
  251. handled correctly.
  252.  
  253. If you find a bug in xpdf, i.e., if it prints an error message,
  254. crashes, or incorrectly displays a document, and you don't see that
  255. bug listed here, please send me email, with a pointer (URL, ftp site,
  256. etc.) to the PDF file.
  257.  
  258.  
  259. Acknowledgments
  260. ---------------
  261.  
  262. Thanks to:
  263.  
  264. * Patrick Voigt for help with the remote server code.
  265. * Patrick Moreau for the VMS port.
  266. * David Boldt and Rick Rodgers for sample man pages.
  267. * Brendan Miller for the icon idea.
  268. * Olly Betts for help testing pdftotext.
  269. * Peter Ganten for the OS/2 port.
  270.  
  271.  
  272. References
  273. ----------
  274.  
  275. Adobe Systems Inc., _Portable Document Format Reference Manual_.
  276. Addison-Wesley, 1993, ISBN 0-201-62628-4.
  277. [The printed manual for PDF version 1.0.]
  278.  
  279. Adobe Systems Inc., _Portable Document Format Reference Manual_,
  280. Version 1.2.  November 12, 1996.
  281. [Updated manual for PDF 1.2.  Also includes the encryption spec.
  282. Available on the WWW as
  283. http://www.adobe.com/supportservice/devrelations/PDFS/TN/PDFSPEC.PDF .]
  284.  
  285. Adobe Systems Inc., _PostScript Language Reference Manual_, 2nd ed.
  286. Addison-Wesley, 1990, ISBN 0-201-18127-4.
  287. [The official PostScript manual.]
  288.  
  289. Adobe Systems Inc., _Supporting the DCT Filters in PostScript Level
  290. 2_, Adobe Developer Support Technical Note #5116.  1992.
  291. [Description of the DCTDecode filter parameters.]
  292.  
  293. Anonymous, RC4 source code.
  294. [This is the algorithm used to encrypt PDF files.  Available on
  295. various ftp sites, e.g., ftp://ftp.ox.ac.uk/pub/crypto/misc/rc4.tar.gz
  296. or ftp://idea.sec.dsi.unimi.it/pub/crypt/code/rc4.tar.gz .]
  297.  
  298. CCITT, _Blue Book_, Volume VII Fascicle 3: "Terminal Equipment and
  299. Protocols for Telematic Services", Recommendations T.4 and T.6.
  300. [The official Group 3 and 4 fax standards.  These are available on the
  301. net (but misformatted) as
  302. ftp://ftp.uu.net/doc/standards/ccitt/1988/7_3_01.ps and 7_3_02.ps .]
  303.  
  304. L. Peter Deutsch, "ZLIB Compressed Data Format Specification version
  305. 3.3".  RFC 1950.
  306. [Information on the general format used in FlateDecode streams.]
  307.  
  308. L. Peter Deutsch, "DEFLATE Compressed Data Format Specification
  309. version 1.3".  RFC 1951.
  310. [The definition of the compression algorithm used in FlateDecode
  311. streams.]
  312.  
  313. Jim Flowers, "X Logical Font Description Conventions", Version 1.5, X
  314. Consortium Standard, X Version 11, Release 6.1.
  315. [The official specification of X font descriptors, including font
  316. transformation matrices.  Available on the net as
  317. ftp://ftp.x.org/pub/R6.1/xc/doc/hardcopy/XLFD/xlfd.PS.Z .]
  318.  
  319. Foley, van Dam, Feiner, and Hughes, _Computer Graphics: Principles and
  320. Practice_, 2nd ed.  Addison-Wesley, 1990, ISBN 0-201-12110-7.
  321. [Colorspace conversion functions, Bezier spline math.]
  322.  
  323. Robert L. Hummel, _Programmer's Technical Reference: Data and Fax
  324. Communications_.  Ziff-Davis Press, 1993, ISBN 1-56276-077-7.
  325. [CCITT Group 3 and 4 fax decoding.]
  326.  
  327. Christoph Loeffler, Adriaan Ligtenberg, George S. Moschytz, "Practical
  328. Fast 1-D DCT Algorithms with 11 Multiplications".  IEEE Intl. Conf. on
  329. Acoustics, Speech & Signal Processing, 1989, 988-991.
  330. [The fast IDCT algorithm used in the DCTDecode filter.]
  331.  
  332. R. Rivest, "The MD5 Message-Digest Algorithm".  RFC 1321.
  333. [MD5 is used in PDF document encryption.]
  334.  
  335. Gregory K. Wallace, "The JPEG Still Picture Compression Standard".
  336. [Good description of the JPEG standard.  Available on the net as
  337. ftp://ftp.uu.net/graphics/jpeg/wallace.ps.gz .  Also published in
  338. CACM, April 1991, and submitted to IEEE Transactions on Consumer
  339. Electronics.]
  340.  
  341. "ISO 8859-2 (Latin 2) Resources".
  342. [This is a web page with all sorts of useful Latin-2 character set and
  343. font information:
  344. http://sizif.mf.uni-lj.si/linux/cee/iso8859-2.html .]
  345.